/*

 * Licensed to the Apache Software Foundation (ASF) under one

 * or more contributor license agreements.  See the NOTICE file

 * distributed with this work for additional information

 * regarding copyright ownership.  The ASF licenses this file

 * to you under the Apache License, Version 2.0 (the

 * "License"); you may not use this file except in compliance

 * with the License.  You may obtain a copy of the License at

 *

 *     http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

package com.bff.gaia.unified.sdk.coders;



import com.bff.gaia.unified.sdk.values.TypeDescriptor;



import java.io.*;



/** A {@link BigEndianShortCoder} encodes {@link Short Shorts} in 4 bytes, big-endian. */

public class BigEndianShortCoder extends AtomicCoder<Short> {



  public static BigEndianShortCoder of() {

    return INSTANCE;

  }



  /////////////////////////////////////////////////////////////////////////////



  private static final BigEndianShortCoder INSTANCE = new BigEndianShortCoder();

  private static final TypeDescriptor<Short> TYPE_DESCRIPTOR = new TypeDescriptor<Short>() {};



  private BigEndianShortCoder() {}



  @Override

  public void encode(Short value, OutputStream outStream) throws IOException {

    if (value == null) {

      throw new CoderException("cannot encode a null Short");

    }

    new DataOutputStream(outStream).writeShort(value);

  }



  @Override

  public Short decode(InputStream inStream) throws IOException, CoderException {

    try {

      return new DataInputStream(inStream).readShort();

    } catch (EOFException | UTFDataFormatException exn) {

      // These exceptions correspond to decoding problems, so change

      // what kind of exception they're branded as.

      throw new CoderException(exn);

    }

  }



  @Override

  public void verifyDeterministic() {}



  /**

   * {@inheritDoc}

   *

   * @return {@code true}. This coder is injective.

   */

  @Override

  public boolean consistentWithEquals() {

    return true;

  }



  /**

   * {@inheritDoc}

   *

   * @return {@code true}, because {@link #getEncodedElementByteSize} runs in constant time.

   */

  @Override

  public boolean isRegisterByteSizeObserverCheap(Short value) {

    return true;

  }



  @Override

  public TypeDescriptor<Short> getEncodedTypeDescriptor() {

    return TYPE_DESCRIPTOR;

  }



  /**

   * {@inheritDoc}

   *

   * @return {@code 2}, the size in bytes of an short's big endian encoding.

   */

  @Override

  protected long getEncodedElementByteSize(Short value) throws Exception {

    if (value == null) {

      throw new CoderException("cannot encode a null Short");

    }

    return 2;

  }

}